home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / C++ / Frameworks / Sprocket Framework DR2 / Sprocket Framework Guide / Starter Guide Script < prev   
Encoding:
Text File  |  1996-06-14  |  6.0 KB  |  162 lines  |  [TEXT/R*ch]

  1. #################################################
  2. #    File:        Sprocket Starter Guide Script
  3. #
  4. #    Contains:    Source code for Sprocket Starter Guide
  5. #
  6. #    Coded by:    Bill Hayden
  7. #    Content by: Bill Hayden
  8. #
  9. #    Copyright:    ©1996 by Nikol Software
  10. #
  11. #################################################
  12.  
  13.  
  14.  
  15. # *****************INITIAL SETUP INFORMATION*****************
  16. <Resource> "Standard Resources", ALL
  17.  
  18. <MAX HEIGHT>    350
  19.  
  20. # *****************Finder file information*********
  21. #Specify the version strings that appear in the Finder Get Info window
  22. # for your guide file
  23. <Version> "1.1fc3, ©1995-6 Nikol Software", "1.1fc3"
  24.  
  25.  
  26. <HELP MENU>    "Sprocket Starter Guide", HELP, "?"
  27. <Balloon Menu Text> "Displays guided help for the Sprocket Starter program."
  28.  
  29.  
  30. # ******************startup window**********
  31. #define startup window, this is the window that Apple Guide 
  32. # first displays when the user chooses the menu item SurfWriter Guide
  33. # If you specify a full access window, you can display HOWDY info OR (note the OR)
  34. # OR you can specify which of the three buttons is initially active
  35. # this example specifies HOWDY
  36. <Startup Window> FULL, HOWDY
  37.  
  38. #You can choose FULL, SINGLE, or PRESENTATION as the startup window
  39. #Full access windows allows topics, index, and look for, and Howdy
  40. #Single access windows allows only topics and howdy
  41. #Presentation allows a single sequence only
  42.  
  43.  
  44. # ******************application logo*******
  45. #Define either SurfWriter app logo or app text.
  46. #Apple Guide displays the app logo or app text
  47. # in the upper-left corner of SurfWriter Guide's Full Access window.
  48. <App Text> "Sprocket Guide"
  49. #if you choose to use app logo instead,
  50. # define the filename that contains a PICT of your app's logo
  51. # for example, <App Logo> "MyAppLogoPict", "MyAppLogoB&WPict"
  52. #(Note that the file "Standard Resources" contains templates with
  53. # PICT resource IDs 1501 and 1502 that you can modify appropriately and
  54. # then use as the application logo picture associated with your guide).
  55. #If you modify the PICT resources with IDs 1501 and 1502 then import the
  56. # "Standard Resources" file, you can omit the <App Logo> command.
  57. #If you store your app logo in a separate file, then remove the PICT resources
  58. # with resource IDs 1501 and 1502 from the "Standard Resources" file.
  59.  
  60. #if you did include your own picture files, it might look something like this
  61. #<App Logo> "Sprocket Color Logo", "Sprocket B&W Logo"
  62.  
  63.  
  64.  
  65. # ******************howdy text**************
  66. #define the text for the Howdy screen 
  67. <Define Text Block> "Howdy Text"
  68. Welcome to Apple Guide help for Worksheet Magic.
  69.  
  70. To start, click Topics, Index, or Look For.
  71.  
  72. Topics shows general categories and Index lists key words. 
  73. Look For lets you search for help according to key words you type.
  74. <End Text Block>
  75.  
  76. #now specify the defined howdy text
  77. <Howdy> "Howdy Text"
  78.  
  79.  
  80. #To specify that your guide file appear only in the Help menu of your application,
  81. #use this command and specify your application's creator, for example :
  82. <App Creator> '75SL'
  83.  
  84.  
  85.  
  86. # ******************events**************
  87. #These events and definitions are also defined in the Standard Setup file
  88.  
  89. #<Define Event> "DoHuh", 's***', 'help', 'dhuh'
  90. <Define Event> "GoStart", 's***', 'help', 'stac'
  91. #<Define Event> "GoBack", 's***', 'help', 'gobk'
  92.  
  93.  
  94. # ******************navigation buttons*****
  95. #<Define Nav Button> "Huh?", 1101, 1111, 1121, DIMMABLE
  96. <Define Nav Button> "GoStart", 1100, 1102, 1104, GoStart()
  97.  
  98. <Define Nav Button Set> "Std nav bar", "GoStart"
  99. #, "Huh?"
  100.  
  101.  
  102.  
  103. <TOPIC AREA> "General Information"
  104. <HEADER> "How do I"
  105.     <TOPIC> "Start a new Sprocket project?" , "Starting a new Sprocket project"
  106.     <TOPIC> "Write an Apple Guide help file?" , "Writing for Apple Guide"
  107. <HEADER> "Definitions"
  108.     <TOPIC> "Sprocket" , "What is Sprocket?"
  109.  
  110.  
  111. <DEFINE PANEL>    "Writing for Apple Guide"
  112. By using the sample files which created the Guide you are reading now, you can have a working Apple Guide help solution up and running in minutes.
  113.  
  114. Withing the Sprocket folder is a folder called Sprocket Guide Files.  In this folder you will find the source for this file, as well as a built copy.  To create a Guide file, you will need Guide Maker, a free Apple Guide creation utility available from Apple.  To edit the source, any text editor such as CodeWarrior or BBEdit will do.
  115.  
  116. Open the source file, and familiar yourself with the easy-to-understand Guide Script.  Try changing a few things, then open Guide Maker.  Click the Build button, then select the source (the file you just edited), and the target (the Sprocket Starter Guide).  Click Build.  Voila!  Now move the new Sprocker Starter Guide into the same folder as Sprocket Starter (68k or PPC).  Launch one of them, and you will see that your new guide is available under the help menu, and can also be triggered by the help key.  In addition, you can open this guide file from within Sprocket, and you can even preset a search string in the guide file you open.
  117. <END PANEL>
  118.  
  119.  
  120. <DEFINE PANEL>    "Starting a new Sprocket project"
  121. To start a new project using the Sprocket Framework, you have two choices:
  122.  
  123. 1.  Make a copy of the SprocketNothing folder, and rename all references to SprocketNothing to whatever you choose.  You will then be starting “from scratch”.
  124.  
  125. 2.  Make a copy of the SprocketStarter folder, and rename all references to SprocketStarter to whatever you choose.  You will then be starting with a base text-editing application which has been designed to provide good examples of many of the key features of Sprocket.
  126. <END PANEL>
  127.  
  128.  
  129. <DEFINE PANEL>    "What is Sprocket?"
  130. xyz
  131. <END PANEL>
  132.  
  133.  
  134. <DEFINE SEQUENCE>    "Starting a new Sprocket project"
  135.       <SNBS> "Std nav bar"
  136.         <PANEL>    "Starting a new Sprocket project"
  137. <END SEQUENCE>
  138.  
  139. <DEFINE SEQUENCE>    "Writing for Apple Guide"
  140.       <SNBS> "Std nav bar"
  141.         <PANEL>    "Writing for Apple Guide"
  142. <END SEQUENCE>
  143.  
  144.  
  145. <DEFINE SEQUENCE>    "What is Sprocket?"
  146.       <SNBS> "Std nav bar"
  147.         <PANEL>    "What is Sprocket?"
  148. <END SEQUENCE>
  149.  
  150.  
  151. #define a single index term
  152. <Index> "Sprocket"
  153.     <Header> "Definitions"
  154.         <Topic> "Sprocket", "What is Sprocket?"
  155.  
  156. <Index> "Apple Guide"
  157.     <Header> "Implementation Assistance"
  158.         <Topic> "Apple Guide", "Writing for Apple Guide"
  159.  
  160. #that's all!!
  161.  
  162.